home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmPushButtonGadget.z / XmPushButtonGadget
Encoding:
Text File  |  1998-10-20  |  41.3 KB  |  595 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt - The PushButtonGadget widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////PPPPuuuusssshhhhBBBBGGGG....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           PushButtonGadget issues commands within an application.  It
  20.           consists of a text label or pixmap surrounded by a border
  21.           shadow.  When PushButtonGadget is selected, the shadow
  22.           changes to give the appearance that the PushButtonGadget has
  23.           been pressed in.  When PushButtonGadget is unselected, the
  24.           shadow changes to give the appearance that the
  25.           PushButtonGadget is out.
  26.  
  27.           The default behavior associated with a PushButtonGadget in a
  28.           menu depends on the type of menu system in which it resides.
  29.           By default, BBBBSSSSeeeelllleeeecccctttt controls the behavior of the
  30.           PushButtonGadget.  In addition, BBBBMMMMeeeennnnuuuu controls the behavior
  31.           of the PushButtonGadget if it resides in a PopupMenu system.
  32.           The actual mouse button used is determined by its RowColumn
  33.           parent.
  34.  
  35.           Thickness for a second shadow may be specified by using the
  36.           XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource.  If it has a non-zero value, the
  37.           Label's resources XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt,
  38.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp, and XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm may be modified to
  39.           accommodate the second shadow.
  40.  
  41.           If an initial value is specified for XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp but not
  42.           for XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp value is used for
  43.           XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp.
  44.  
  45.         CCCCllllaaaasssssssseeeessss
  46.           PushButtonGadget inherits behavior and resources from
  47.           OOOObbbbjjjjeeeecccctttt, RRRReeeeccccttttOOOObbbbjjjj, XXXXmmmmGGGGaaaaddddggggeeeetttt and XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt classes.
  48.  
  49.           The class pointer is xxxxmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttCCCCllllaaaassssssss.
  50.  
  51.           The class name is XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt.
  52.  
  53.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  54.           The following table defines a set of widget resources used
  55.           by the programmer to specify data.  The programmer can also
  56.           set the resource values for the inherited classes to set
  57.           attributes for this widget.  To reference a resource by name
  58.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  59.           prefix and use the remaining letters.  To specify one of the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           defined values for a resource in a .Xdefaults file, remove
  75.           the XXXXmmmm prefix and use the remaining letters (in either
  76.           lowercase or uppercase, but include any underscores between
  77.           words).  The codes in the access column indicate if the
  78.           given resource can be set at creation time (C), set by using
  79.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  80.           not applicable (N/A).
  81.  
  82.                                                      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt
  83.      NNNNaaaammmmeeee                              CCCCllllaaaassssssss                             TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  84.      __________________________________________________________________________________________________________________
  85.      XmNactivateCallback               XmCCallback                       XtCallbackList   NULL                   C
  86.      XmNarmCallback                    XmCCallback                       XtCallbackList   NULL                   C
  87.      XmNarmColor                       XmCArmColor                       Pixel            dynamic                CSG
  88.      XmNarmPixmap                      XmCArmPixmap                      Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  89.      XmNdefaultButtonShadowThickness   XmCdefaultButtonShadowThickness   Dimension        dynamic                CSG
  90.      XmNdisarmCallback                 XmCCallback                       XtCallbackList   NULL                   C
  91.      XmNfillOnArm                      XmCFillOnArm                      Boolean          True                   CSG
  92.      XmNmultiClick                     XmCMultiClick                     unsigned char    dynamic                CSG
  93.      XmNshowAsDefault                  XmCShowAsDefault                  Dimension        0                      CSG
  94.  
  95.  
  96.           XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  97.                     Specifies the list of callbacks that is called
  98.                     when the PushButtonGadget is activated.  It is
  99.                     activated when the user presses and releases the
  100.                     active mouse button while the pointer is inside
  101.                     the PushButtonGadget.  Activating PushButtonGadget
  102.                     also disarms it.  For this callback the reason is
  103.                     XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.
  104.  
  105.           XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  106.                     Specifies the list of callbacks that is called
  107.                     when PushButtonGadget is armed.  It is armed when
  108.                     the user presses the active mouse button while the
  109.                     pointer is inside the PushButtonGadget.  For this
  110.                     callback the reason is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
  111.  
  112.           XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr
  113.                     Specifies the color with which to fill the armed
  114.                     button.  XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm must be set to True for this
  115.                     resource to have an effect.  The default for a
  116.                     color display is a color between the background
  117.                     and the bottom shadow color.  For a monochrome
  118.                     display, the default is set to the foreground
  119.                     color, and any text in the label appears in the
  120.                     background color when the button is armed.
  121.  
  122.           XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp
  123.                     Specifies the pixmap to be used as the button face
  124.                     if XXXXmmmmNNNNllllaaaabbbbeeeellllttttyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP and PushButtonGadget
  125.                     is armed.  This resource is disabled when the
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     PushButtonGadget is in a menu.
  141.  
  142.           XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss
  143.                     This resource specifies the width of the default
  144.                     button indicator shadow.  If this resource is
  145.                     zero, the width of the shadow comes from the value
  146.                     of the XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource.  If this
  147.                     resource is greater than zero, the
  148.                     XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt resource is only used to specify
  149.                     whether this button is the default.  The default
  150.                     value is the initial value of XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt.
  151.  
  152.           XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  153.                     Specifies the list of callbacks that is called
  154.                     when the PushButtonGadget is disarmed.
  155.                     PushButtonGadget is disarmed when the user presses
  156.                     and releases the active mouse button while the
  157.                     pointer is inside that gadget.  For this callback,
  158.                     the reason is XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
  159.  
  160.           XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm
  161.                     Forces the PushButtonGadget to fill the background
  162.                     of the button with the color specified by
  163.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr when the button is armed and when this
  164.                     resource is set to True.  If False, only the top
  165.                     and bottom shadow colors are switched.  When the
  166.                     PushButtonGadget is in a menu, this resource is
  167.                     ignored and assumed to be False.
  168.  
  169.           XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  170.                     If a button click is followed by another button
  171.                     click within the time span specified by the
  172.                     display's multi-click time, and this resource is
  173.                     set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, do not process the
  174.                     second click.  If this resource is set to
  175.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, process the event and increment
  176.                     _c_l_i_c_k__c_o_u_n_t in the callback structure.  When the
  177.                     button is in a menu, the default is
  178.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD; otherwise, for a button not
  179.                     in a menu XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP is the default value.
  180.  
  181.           XXXXmmmmNNNNsssshhhhoooowwwwAAAAssssDDDDeeeeffffaaaauuuulllltttt
  182.                     If XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is greater than
  183.                     zero, a value greater than zero in this resource
  184.                     specifies to mark this button as the default
  185.                     button.  If XXXXmmmmNNNNddddeeeeffffaaaauuuullllttttBBBBuuuuttttttttoooonnnnSSSShhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is
  186.                     zero, a value greater than zero in this resource
  187.                     specifies to mark this button as the default
  188.                     button with the shadow thickness specified by this
  189.                     resource.  The space between the shadow and the
  190.                     default shadow is equal to the sum of both
  191.                     shadows.  The default value is zero.  When this
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     value is not zero, the Label resources
  207.                     XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt, XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp, and
  208.                     XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm may be modified to accommodate the
  209.                     second shadow.  This resource is disabled when the
  210.                     PushButton is in a menu.
  211.  
  212.  
  213.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  214.           PushButtonGadget inherits behavior and resources from the
  215.           following superclasses.  For a complete description of each
  216.           resource, refer to the man page for that superclass.
  217.  
  218.                                             XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  219.      NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  220.      _________________________________________________________________________________________________________
  221.      XmNaccelerator              XmCAccelerator              String              NULL                   CSG
  222.      XmNacceleratorText          XmCAcceleratorText          XmString            NULL                   CSG
  223.      XmNalignment                XmCAlignment                unsigned char       dynamic                CSG
  224.      XmNfontList                 XmCFontList                 XmFontList          dynamic                CSG
  225.      XmNlabelInsensitivePixmap   XmCLabelInsensitivePixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  226.      XmNlabelPixmap              XmCLabelPixmap              Pixmap              dynamic                CSG
  227.      XmNlabelString              XmCXmString                 XmString            dynamic                CSG
  228.      XmNlabelType                XmCLabelType                unsigned char       XmSTRING               CSG
  229.      XmNmarginBottom             XmCMarginBottom             Dimension           dynamic                CSG
  230.      XmNmarginHeight             XmCMarginHeight             Dimension           2                      CSG
  231.      XmNmarginLeft               XmCMarginLeft               Dimension           dynamic                CSG
  232.      XmNmarginRight              XmCMarginRight              Dimension           dynamic                CSG
  233.      XmNmarginTop                XmCMarginTop                Dimension           dynamic                CSG
  234.      XmNmarginWidth              XmCMarginWidth              Dimension           2                      CSG
  235.      XmNmnemonic                 XmCMnemonic                 KeySym              NULL                   CSG
  236.      XmNmnemonicCharSet          XmCMnemonicCharSet          String              dynamic                CSG
  237.      XmNrecomputeSize            XmCRecomputeSize            Boolean             True                   CSG
  238.      XmNstringDirection          XmCStringDirection          XmStringDirection   dynamic                CSG
  239.  
  240.                                     XXXXmmmmGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  241.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  242.      ___________________________________________________________________________________
  243.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic   G
  244.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL      C
  245.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic   G
  246.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False     CSG
  247.      XmNhighlightThickness   XmCHighlightThickness   Dimension          2         CSG
  248.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE    CSG
  249.      XmNshadowThickness      XmCShadowThickness      Dimension          2         CSG
  250.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic   G
  251.      XmNtraversalOn          XmCTraversalOn          Boolean            True      CSG
  252.      XmNunitType             XmCUnitType             unsigned char      dynamic   CSG
  253.      XmNuserData             XmCUserData             XtPointer          NULL      CSG
  254.  
  255.                               RRRReeeeccccttttOOOObbbbjjjj RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  269.  
  270.  
  271.  
  272.       NNNNaaaammmmeeee                   CCCCllllaaaassssssss            TTTTyyyyppppeeee        DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  273.       ____________________________________________________________________
  274.       XmNancestorSensitive   XmCSensitive     Boolean     dynamic   G
  275.       XmNborderWidth         XmCBorderWidth   Dimension   0         CSG
  276.       XmNheight              XmCHeight        Dimension   dynamic   CSG
  277.       XmNsensitive           XmCSensitive     Boolean     True      CSG
  278.       XmNwidth               XmCWidth         Dimension   dynamic   CSG
  279.       XmNx                   XmCPosition      Position    0         CSG
  280.       XmNy                   XmCPosition      Position    0         CSG
  281.  
  282.                               OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  283.       NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  284.       ____________________________________________________________________
  285.       XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  286.  
  287.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  288.           A pointer to the following structure is passed to each
  289.           callback:
  290.  
  291.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  292.           {{{{
  293.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  294.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  295.             iiiinnnntttt      _c_l_i_c_k__c_o_u_n_t;;;;
  296.           }}}} XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  297.  
  298.  
  299.           _r_e_a_s_o_n Indicates why the callback was invoked.
  300.  
  301.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback.
  302.  
  303.           _c_l_i_c_k__c_o_u_n_t
  304.                  This value is valid only when the reason is
  305.                  XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.  It contains the number of clicks in
  306.                  the last multiclick sequence if the XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  307.                  resource is set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, otherwise it
  308.                  contains 1111.  The activate callback is invoked for
  309.                  each click if XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is set to
  310.                  XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
  311.  
  312.  
  313.         BBBBeeeehhhhaaaavvvviiiioooorrrr
  314.           XmPushButtonGadget includes behavior from XmGadget.
  315.           XmPushButtonGadget includes menu traversal behavior from
  316.           XmLabelGadget.  Additional behavior for XmPushButtonGadget
  317.           is described below:
  318.  
  319.  
  320.           BBBBDDDDrrrraaaagggg PPPPrrrreeeessssssss:
  321.                     Drags the contents of a PushButtonGadget label,
  322.                     identified by pressing BBBBDDDDrrrraaaagggg.  This action creates
  323.                     a DragContext object whose XXXXmmmmNNNNeeeexxxxppppoooorrrrttttTTTTaaaarrrrggggeeeettttssss
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  335.  
  336.  
  337.  
  338.                     resource is set to "COMPOUND_TEXT" for a label
  339.                     type of XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG; otherwise, "PIXMAP" if the label
  340.                     type is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  This action is undefined for
  341.                     PushButtonGadgets used in a menu system.
  342.  
  343.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:
  344.                     This action arms the PushButtonGadget.
  345.  
  346.                     In a menu, this action unposts any menus posted by
  347.                     the PushButtonGadget's parent menu, disables
  348.                     keyboard traversal for the menu, and enables mouse
  349.                     traversal for the menu.  It draws the shadow in
  350.                     the armed state.  Unless the button is already
  351.                     armed, it calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  352.  
  353.                     If the button is not in a menu, this action draws
  354.                     the shadow in the armed state.  If XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is
  355.                     set to True, it fills the button with the color
  356.                     specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  357.                     XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used for the button
  358.                     face.  It calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  359.  
  360.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss 2222++++:
  361.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  362.                     action does nothing.
  363.  
  364.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
  365.                     does the following:  Draws the shadow in the armed
  366.                     state.  If the button is not in a menu and if
  367.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, fills the button with
  368.                     the color specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If
  369.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used
  370.                     for the button face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  371.                     callbacks.
  372.  
  373.           BBBBSSSSeeeelllleeeecccctttt CCCClllliiiicccckkkk oooorrrr BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee:
  374.                     In a menu, this action unposts all menus in the
  375.                     menu hierarchy and activates the PushButtonGadget.
  376.                     It calls the XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk callbacks and
  377.                     then the XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  378.  
  379.                     If the PushButtonGadget is not in a menu, this
  380.                     action draws the shadow in the unarmed state.  If
  381.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, the background color
  382.                     reverts to the unarmed color.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  383.                     XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is used for the
  384.                     button face.  If the pointer is still within the
  385.                     button, this action calls the callbacks for
  386.                     XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  Calls the callbacks for
  387.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  388.  
  389.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee 2222++++:
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/30/98)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  401.  
  402.  
  403.  
  404.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  405.                     action does nothing.
  406.  
  407.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
  408.                     does the following:  Increments _c_l_i_c_k__c_o_u_n_t in the
  409.                     callback structure.  Draws the shadow in the
  410.                     unarmed state.  If the button is not in a menu and
  411.                     if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, the background
  412.                     color reverts to the unarmed color.  If
  413.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  414.                     used for the button face.  If the pointer is
  415.                     within the PushButtonGadget, calls the callbacks
  416.                     for XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  Calls the callbacks for
  417.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  418.  
  419.           KKKKAAAAccccttttiiiivvvvaaaatttteeee:
  420.                     In a menu, does the following: unposts all menus
  421.                     in the menu hierarchy; unless the button is
  422.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks;
  423.                     and calls the XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk and
  424.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.  Outside a menu,
  425.                     KKKKAAAAccccttttiiiivvvvaaaatttteeee has no effect.  For PushButtonGadgets
  426.                     outside of a menu, if the parent is a manager,
  427.                     this action passes the event to the parent.
  428.  
  429.           KKKKSSSSeeeelllleeeecccctttt:  In a menu, does the following:  Unposts all menus
  430.                     in the menu hierarchy.  Unless the button is
  431.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  432.                     Calls the XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk and
  433.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  434.  
  435.                     Outside a menu, does the following:  Draws the
  436.                     shadow in the armed state and, if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is
  437.                     set to True, fills the button with the color
  438.                     specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is
  439.                     XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is used for the button
  440.                     face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  441.  
  442.                     Outside a menu, this action also arranges for the
  443.                     following to happen, either immediately or at a
  444.                     later time:  The shadow is drawn in the unarmed
  445.                     state and, if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, the
  446.                     background color reverts to the unarmed color.  If
  447.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  448.                     used for the button face.  The XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  449.                     and XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks are called.
  450.  
  451.           KKKKHHHHeeeellllpppp:    In a Pulldown or Popup MenuPane, unposts all menus
  452.                     in the menu hierarchy and restores keyboard focus
  453.                     to the widget that had the focus before the menu
  454.                     system was entered.  Calls the callbacks for
  455.                     XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any exist.  If there are no
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 4/30/98)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  467.  
  468.  
  469.  
  470.                     help callbacks for this widget, this action calls
  471.                     the help callbacks for the nearest ancestor that
  472.                     has them.
  473.  
  474.           MMMMAAAAnnnnyyyy KKKKCCCCaaaannnncccceeeellll:
  475.                     In a toplevel Pulldown MenuPane from a MenuBar,
  476.                     unposts the menu, disarms the MenuBar
  477.                     CascadeButton and the MenuBar, and restores
  478.                     keyboard focus to the widget that had the focus
  479.                     before the MenuBar was entered.  In other Pulldown
  480.                     MenuPanes, unposts the menu.
  481.  
  482.                     In a Popup MenuPane, unposts the menu and restores
  483.                     keyboard focus to the widget from which the menu
  484.                     was posted.  For a PushButtonGadget outside of a
  485.                     menu, if the parent is a manger, this action
  486.                     passes the event to the parent.
  487.  
  488.           <<<<EEEEnnnntttteeeerrrr>>>>:  In a menu, if keyboard traversal is enabled, this
  489.                     action does nothing.  Otherwise, it draws the
  490.                     shadow in the armed state and calls the
  491.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  492.  
  493.                     If the PushButtonGadget is not in a menu and the
  494.                     cursor leaves and then reenters the
  495.                     PushButtonGadget while the button is pressed, this
  496.                     action draws the shadow in the armed state.  If
  497.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to True, it also fills the
  498.                     button with the color specified by XXXXmmmmNNNNaaaarrrrmmmmCCCCoooolllloooorrrr.
  499.                     If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNaaaarrrrmmmmPPPPiiiixxxxmmmmaaaapppp is
  500.                     used for the button face.
  501.  
  502.           <<<<LLLLeeeeaaaavvvveeee>>>>:  In a menu, if keyboard traversal is enabled, this
  503.                     action does nothing.  Otherwise, it draws the
  504.                     shadow in the unarmed state and calls the
  505.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  506.  
  507.                     If the PushButtonGadget is not in a menu and the
  508.                     cursor leaves the PushButtonGadget while the
  509.                     button is pressed, this action draws the shadow in
  510.                     the unarmed state.  If XXXXmmmmNNNNffffiiiillllllllOOOOnnnnAAAArrrrmmmm is set to
  511.                     True, the background color reverts to the unarmed
  512.                     color.  If XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the
  513.                     XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is used for the button face.
  514.  
  515.  
  516.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  517.           The bindings for virtual keys are vendor specific.  For
  518.           information about bindings for virtual buttons and keys, see
  519.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  520.  
  521.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  522.  
  523.  
  524.  
  525.      PPPPaaaaggggeeee 8888                                          ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888))))
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  533.  
  534.  
  535.  
  536.           OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), RRRReeeeccccttttOOOObbbbjjjj((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeePPPPuuuusssshhhhBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))),
  537.           XXXXmmmmGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt((((3333XXXX)))), and XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))).
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 4/30/98)
  592.  
  593.  
  594.  
  595.